home *** CD-ROM | disk | FTP | other *** search
/ PC World Komputer 2010 April / PCWorld0410.iso / hity wydania / Ubuntu 9.10 PL / karmelkowy-koliberek-desktop-9.10-i386-PL.iso / casper / filesystem.squashfs / usr / share / doc / brltty / README-KTB < prev    next >
Text File  |  2009-05-14  |  3KB  |  65 lines
  1. Key Tables
  2. ----------
  3.  
  4. Files with names of the form *.ktb are key tables, and with names of the form 
  5. *.kti are key subtables. They are used by BRLTTY to bind keyboard key 
  6. combinations to BRLTTY commands.
  7.  
  8. A key table consists of a sequence of directives, one per line, which define 
  9. what each key combination is to be bound to. UTF-8 character encoding must be 
  10. used. White-space (blanks, tabs) at the beginning of a line, as well as before 
  11. and/or after any operand, is ignored. Lines containing only white-space are 
  12. ignored. If the first non-white-space character of a line is "#" then that line 
  13. is a comment and is ignored.
  14.  
  15. ===============================================================================
  16.  
  17. The Bind Directive
  18. ------------------
  19.  
  20.    bind <keys> <command> # <comment>
  21.  
  22. Use the "bind" directive to bind a key combination to a command.
  23.  
  24. The <keys> operand specifies the key combination to be bound. It is a sequence 
  25. of one or more key names (see the file "ktb_keynames.h" within the "Programs" 
  26. subdirectory of BRLTTY's source tree) separated by plus (+) signs. The initial 
  27. keys are known as modifiers and may be pressed in any order. The last key must 
  28. be pressed while all the modifiers are being held.
  29.  
  30. The <command> operand specifies the name of a BRLTTY command (see the 
  31. "cmds.auto.h" file within the "Programs" subdirectory of BRLTTY's build tree).
  32. *  For feature activation commands:
  33.    +  If no modifier is appended then the state of the feature is toggled.
  34.    +  If the modifier +on is appended then the feature is turned on.
  35.    +  If the modifier +off is appended then the feature is turned off.
  36. *  For character commands: The command acts on the character where the cursor 
  37.    is.
  38. *  For base commands: The modifier +<n>, wehre <n> is a non-negative integer,
  39.    may be appended. If this modifier isn't specified then 0 is assumed.
  40.  
  41. Examples:
  42.  
  43.    bind CapsLock+Enter CsrTrk
  44.    bind CapsLock+O CsrTrk+off
  45.    bind CapsLock+P CsrTrk+on
  46.    bind KPInsert+1 GoToMark+1
  47.  
  48. ===============================================================================
  49.  
  50. The Include Directive
  51. ---------------------
  52.  
  53.    include <file> # <comment>
  54.  
  55. Use the "include" directive to include the content of a key subtable. It is 
  56. recursive, which means that any key subtable can itself include yet another key 
  57. subtable. Care must be taken to ensure that an "include loop" is not created.
  58.  
  59. The <file> operand specifies the file to be included. It may be either a 
  60. relative or an absolute path. If relative, it is anchored at the directory 
  61. containing the including file.
  62.  
  63. ===============================================================================
  64.  
  65.